﻿//AcademicPlanner - course registration planning web app.
//Copyright (C) 2009  Boubacar Diallo

//This program is free software; you can redistribute it and/or
//modify it under the terms of the GNU General Public License
//as published by the Free Software Foundation; either version 2
//of the License, or (at your option) any later version.

//This program is distributed in the hope that it will be useful,
//but WITHOUT ANY WARRANTY; without even the implied warranty of
//MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//GNU General Public License for more details.

//You should have received a copy of the GNU General Public License
//along with this program; if not, write to the Free Software
//Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.


using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace AcademicPlanner.Data.Entities
{
	/// <summary>
	/// CourseEntity represents the data aspect of a domain layer's <c>Course</c>.
	/// </summary>
	/// <since>1.0</since>
	public class CourseEntity : Entity
	{
		/// <summary>
		/// Gets or sets the name of this CourseEntity.
		/// </summary>
		/// <since>1.0</since>
		public virtual string Name { get; set; }

		/// <summary>
		/// Gets or sets the academic number of this CourseEntity.
		/// </summary>
		/// <since>1.0</since>
		public virtual int Number { get; set; }

		/// <summary>
		/// Gets or sets the number of credits this CourseEntity is worth.
		/// </summary>
		/// <since>1.0</since>
		public virtual double Num_Credits { get; set; }

		/// <summary>
		/// Gets or sets the <c>CourseCategoryEntity</c> of this CourseEntity.
		/// </summary>
		/// <since>1.0</since>
		public virtual CourseCategoryEntity CategoryEntity { get; set; }

		/// <summary>
		/// Gets or sets the list of <c>CourseEntity</c>s that are academic prerequisites to this CourseEntity.
		/// </summary>
		/// <since>1.0</since>
		public virtual IList<CourseEntity> PrerequiredCourseEntities { get; set; }

		/// <summary>
		/// Gets or sets the list <c>AcademicTermEntity</c>s this CourseEntity is commonly offered in.
		/// </summary>
		/// <since>1.0</since>
		public virtual IList<AcademicTermEntity> CommonlyOfferedTermEntities { get; set; }


		/// <summary>
		/// Sets default values for this CourseEntity's properites.
		/// </summary>
		/// <remarks>
		/// <c>Name</c> is set to <c>""</c>.
		/// <c>PrerequiredCourseEntities</c> and <c>CommonlyOfferedTermEntities</c>
		/// are set to empty lists.
		/// </remarks>
		/// <since>1.0</since>
		public override void SetDefaults()
		{
			base.SetDefaults();
			Name = "";
			PrerequiredCourseEntities = new List<CourseEntity>();
			CommonlyOfferedTermEntities = new List<AcademicTermEntity>();
		}
	}
}
